/*=========================================================================
 Copyright (c) 2008, Nokia Corporation and/or its subsidiary(-ies).
 All rights reserved.

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 
     * Redistributions of source code must retain the above copyright
       notice, this list of conditions and the following disclaimer.
     * Redistributions in binary form must reproduce the above copyright
       notice, this list of conditions and the following disclaimer in the
       documentation and/or other materials provided with the distribution.
     * Neither the name of the Nokia Corporation and/or its subsidiary(-ies)nor the
       names of its contributors may be used to endorse or promote products
       derived from this software without specific prior written permission.

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
 EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
 THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
 OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR 
 TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
=========================================================================================*/

#ifndef NCVEGOMOVEMENT_H
#define NCVEGOMOVEMENT_H

#include <e32def.h>
#include "ncvFixed.h"

/**
 * \class CEgoMovement
 * \brief Simple vector-like wrapper class for pixel motion estimation values
 *
 *
 * \note Symbian TClass.
 */

class CEgoMovement
	{
public:

	/**
	 * \var iX
	 * \brief Movement along the x-axis.
	 */
	CFixed iX;

	/**
	 * \var iY
	 * \brief Movement along the y-axis.
	 */
	CFixed iY;

public:
	/**
	 * \brief Constructor. Initializes movement to (0, 0).
	 */
	IMPORT_C CEgoMovement();

	/**
	 * \brief Constructor.
	 * \param aX Movement along the x-axis.
	 * \param aY Movement along the y-axis.
	 */
	IMPORT_C CEgoMovement(const CFixed aX, const CFixed aY);

	/** \name Math operations.
	 * \brief Basic mathematical scalar and vector multiplication and vector sums.
	 * \param aMovement Vector movement.
	 * \param aFactor Scalar factor.
	 * \return Respective movement.
	 */
	//@{

	IMPORT_C CEgoMovement operator+(const CEgoMovement& aMovement);
	IMPORT_C CEgoMovement& operator+=(const CEgoMovement& aMovement);
	IMPORT_C CEgoMovement operator-(const CEgoMovement& aMovement);
	IMPORT_C CEgoMovement& operator-=(const CEgoMovement& aMovement);
	IMPORT_C CEgoMovement operator*(const CFixed& aFactor);
	IMPORT_C CEgoMovement& operator*=(const CFixed& aFactor);
	IMPORT_C CEgoMovement operator/(const CFixed& aFactor);
	IMPORT_C CEgoMovement& operator/=(const CFixed& aFactor);
	//@}

	/** \name Comparison operations.
	 * \brief Basic comparison operations.
	 * \param aMovement Vector movement.
	 * \return Boolean.
	 */
	//@{
	IMPORT_C TBool operator==(const CEgoMovement& aMovement);
	IMPORT_C TBool operator!=(const CEgoMovement& aMovement);
	//@}

	/**
	 * \brief Calculates the euclidian norm of the movement.
	 * \return Norm (the length of the movement in cartesian coordinate system).
	 */
	IMPORT_C CFixed Norm();

	/**
	 * \brief Normalizes the movement so that Norm() yields unity.
	 */
	IMPORT_C void Normalize();

	/**
	 * \brief Calculates a dot product.
	 * \param aMovement Vector movement.
	 * \return Dot product value.
	 */
	IMPORT_C CFixed DotProduct(const CEgoMovement& aMovement);

	};

#endif /* NCVEGOMOVEMENT_H */
